Sandbox/Old transformation structure/boxcox.R

In akreutzmann/trafo: Estimation, Comparison and Selection of Transformations

#' Box-Cox Transformation
#'
#' Transforms the dependent variable of a regression model using the Box-Cox
#' transformation. The regression model can be a linear or a linear mixed model 
#' with one random intercept. 
#' 
#' @param object an object of type lm or lme. 
#' @param ... other parameters that can be passed to the function.
#' @return The return depends on the class of its argument. The 
#' documentation of particular methods gives detailed information about the 
#' return of that method.
#' @seealso  \code{\link{boxcox.lm}}, \code{\link{boxcox.lme}}
#' @keywords Box-Cox
#' @export
boxcox <- function(object,...) UseMethod("boxcox")